home *** CD-ROM | disk | FTP | other *** search
/ BMUG Revelations / BMUG Revelations.toast / Programming / Programming Languages / Harvest C / MPW Int & Lib / Interfaces / HyperXCmd.h < prev    next >
Text File  |  1991-04-17  |  11KB  |  247 lines
  1. /*
  2.     HyperXCmd.h
  3.     Definition file for HyperCard XCMDs and XFCNs in C.
  4.     Copyright Apple Computer, Inc.  1987-1990
  5.     All rights reserved
  6.  
  7. */
  8.  
  9.  
  10. #ifndef    __HYPERXCMD__
  11. #define    __HYPERXCMD__
  12.  
  13.  
  14. /* Unlike the old days, we have to make sure we have some definitions first… */
  15.  
  16. #ifndef  __TYPES__
  17. #include <Types.h>
  18. #endif
  19.  
  20. #ifndef __EVENTS__
  21. #include <Events.h>
  22. #endif
  23.  
  24. #ifndef __TEXTEDIT__
  25. #include <TextEdit.h>
  26. #endif
  27.  
  28. #ifndef __MENUS__
  29. #include <Menus.h>
  30. #endif
  31.  
  32. #ifndef __STANDARDFILE__
  33. #include <StandardFile.h>
  34. #endif
  35.  
  36.  
  37.  
  38. /* result codes */
  39. #define xresSucc                0
  40. #define xresFail                1
  41. #define xresNotImp                2
  42.  
  43. /* XCMDBlock constants for event.what... */
  44. #define xOpenEvt                1000    /* the first event after you are created */
  45. #define xCloseEvt                1001    /* your window is being forced close (Quit?) */
  46. #define xGiveUpEditEvt            1002    /* you are losing Edit... */
  47. #define xGiveUpSoundEvt            1003    /* you are losing the sound channel... */
  48. #define xHidePalettesEvt        1004    /* someone called HideHCPalettes */
  49. #define xShowPalettesEvt        1005    /* someone called ShowHCPalettes */
  50. #define xEditUndo                1100    /* Edit——Undo */
  51. #define xEditCut                1102    /* Edit——Cut */
  52. #define xEditCopy                1103    /* Edit——Copy */
  53. #define xEditPaste                1104    /* Edit——Paste */
  54. #define xEditClear                1105    /* Edit——Clear */
  55. #define xSendEvt                1200    /* script has sent you a message (text) */
  56. #define xSetPropEvt                1201    /* set a window property */
  57. #define xGetPropEvt                1202    /* get a window property */
  58. #define xCursorWithin            1300    /* cursor is within the window */
  59. #define xMenuEvt                1400    /* user has selected an item in your menu */
  60. #define xMBarClickedEvt            1401    /* a menu is about to be shown--update if needed */
  61.  
  62. #define xShowWatchInfoEvt        1501    /* for variable and message watchers */
  63. #define xScriptErrorEvt            1502    /* place the insertion point */
  64. #define xDebugErrorEvt            1503    /* user clicked "Debug" at a complaint */
  65. #define xDebugStepEvt            1504    /* hilite the line */
  66. #define xDebugTraceEvt            1505    /* same as step but tracing */
  67. #define xDebugFinishedEvt        1506    /* script ended */
  68.  
  69. #define paletteProc                2048    /* Windoid with grow box */
  70. #define palNoGrowProc            2052    /* standard Windoid defproc */
  71. #define palZoomProc                2056    /* Windoid with zoom and grow */
  72. #define palZoomNoGrow            2060    /* Windoid with zoom and no grow */
  73. #define hasZoom                    8
  74. #define hasTallTBar                2
  75. #define toggleHilite            1
  76.  
  77.  
  78. #define maxCachedChecks            16        /* maximum number of checkpoints in a script */
  79.  
  80.  
  81. /* paramCount is set to these constants when first calling special XThings */
  82. #define xMessageWatcherID        = -2;
  83. #define xVariableWatcherID        = -3;
  84. #define xScriptEditorID            = -4;
  85. #define xDebuggerID                = -5;
  86.  
  87. /* XTalkObjectPtr->objectKind values */
  88. #define stackObj                1
  89. #define bkgndObj                2
  90. #define cardObj                    3
  91. #define fieldObj                4
  92. #define buttonObj                5
  93.  
  94.  
  95. typedef struct XCmdBlock *XCmdPtr; 
  96. struct XCmdBlock {
  97.     short paramCount;         /* If = -1 then new use for XWindoids */
  98.     Handle params[16];
  99.     Handle returnValue;
  100.     Boolean passFlag;
  101.  
  102.     Ptr entryPoint;             /* to call back to HyperCard */
  103.     short request;
  104.     short result;
  105.     long inArgs[8];
  106.     long outArgs[4];
  107. };
  108.  
  109. typedef struct XWEventInfo *XWEventInfoPtr; 
  110. struct XWEventInfo {
  111.     EventRecord event;
  112.     WindowPtr eventWindow;
  113.     long eventParams[9];
  114.     Handle eventResult;
  115. };
  116.  
  117. typedef struct XTalkObject *XTalkObjectPtr;
  118. struct XTalkObject {
  119.     short objectKind;        /* stack, bkgnd, card, field, or button */
  120.     long stackNum;            /* reference number of the source stack */
  121.     long bkgndID;
  122.     long cardID;
  123.     long buttonID;
  124.     long fieldID;
  125. };
  126.  
  127.  
  128. typedef struct CheckPts *CheckPtPtr;
  129. typedef CheckPtPtr *CheckPtHandle; 
  130. struct CheckPts {
  131.     short checks[maxCachedChecks];
  132. };
  133.  
  134.  
  135. /****  HyperTalk Utilities  ****/
  136. extern pascal Handle EvalExpr(XCmdPtr paramPtr, StringPtr expr);
  137. extern pascal void SendCardMessage(XCmdPtr paramPtr, StringPtr msg);
  138. extern pascal void SendHCMessage(XCmdPtr paramPtr, StringPtr msg);
  139. extern pascal void RunHandler(XCmdPtr paramPtr, Handle handler);
  140.  
  141. /****  Memory Utilities  ****/
  142. extern pascal Handle GetGlobal(XCmdPtr paramPtr, StringPtr globName);
  143. extern pascal void SetGlobal(XCmdPtr paramPtr, StringPtr globName, Handle globValue);
  144. extern pascal void ZeroBytes(XCmdPtr paramPtr, Ptr dstPtr, long longCount);
  145.  
  146. /****  String Utilities  ****/
  147. extern pascal void ScanToReturn(XCmdPtr paramPtr, Ptr *scanPtr);
  148. extern pascal void ScanToZero(XCmdPtr paramPtr, Ptr *scanPtr);
  149. extern pascal Boolean StringEqual(XCmdPtr paramPtr, StringPtr str1, StringPtr str2);
  150. extern pascal long StringLength(XCmdPtr paramPtr, Ptr strPtr);
  151. extern pascal Ptr StringMatch(XCmdPtr paramPtr, StringPtr pattern, Ptr target);
  152. extern pascal void ZeroTermHandle(XCmdPtr paramPtr, Handle hndl);                                
  153.  
  154. /****  String Conversions  ****/
  155. extern pascal void BoolToStr(XCmdPtr paramPtr, Boolean bool, StringPtr str);
  156. extern pascal void ExtToStr(XCmdPtr paramPtr, extended num, StringPtr str);
  157. extern pascal void LongToStr(XCmdPtr paramPtr, long posNum, StringPtr str);
  158. extern pascal void NumToHex(XCmdPtr paramPtr, long num, short nDigits, StringPtr str);
  159. extern pascal void NumToStr(XCmdPtr paramPtr, long num, StringPtr str);
  160. extern pascal Handle PasToZero(XCmdPtr paramPtr, StringPtr str);
  161. extern pascal void PointToStr(XCmdPtr paramPtr, Point pt, StringPtr str);                        
  162. extern pascal void RectToStr(XCmdPtr paramPtr, Rect *rct, StringPtr str);                        
  163. extern pascal void ReturnToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  164. extern pascal Boolean StrToBool(XCmdPtr paramPtr, StringPtr str);
  165. extern pascal extended StrToExt(XCmdPtr paramPtr, StringPtr str);
  166. extern pascal long StrToLong(XCmdPtr paramPtr, StringPtr str);
  167. extern pascal long StrToNum(XCmdPtr paramPtr, StringPtr str);
  168. extern pascal void StrToPoint(XCmdPtr paramPtr, StringPtr str, Point *pt);                        
  169. extern pascal void StrToRect(XCmdPtr paramPtr, StringPtr str, Rect *rct);                        
  170. extern pascal void ZeroToPas(XCmdPtr paramPtr, Ptr zeroStr, StringPtr pasStr);
  171.  
  172. /****  Field Utilities  ****/
  173. extern pascal Handle GetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID);
  174. extern pascal Handle GetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag, StringPtr fieldName);
  175. extern pascal Handle GetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum);
  176. extern pascal void SetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  177.     Handle fieldVal);
  178. extern pascal void SetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag,
  179.     StringPtr fieldName, Handle fieldVal);
  180. extern pascal void SetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum,
  181.     Handle fieldVal);
  182. extern pascal TEHandle GetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  183.     short fieldNum, StringPtr fieldNamePtr);                                                    
  184. extern pascal void SetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
  185.     short fieldNum, StringPtr fieldNamePtr, TEHandle fieldTE);                                    
  186.  
  187. /****  Miscellaneous Utilities  ****/  /* ALL NEW */
  188. extern pascal void BeginXSound(XCmdPtr paramPtr);
  189. extern pascal void EndXSound(XCmdPtr paramPtr);
  190. extern pascal Boolean GetFilePath(XCmdPtr paramPtr, StringPtr fileName, short numTypes, SFTypeList typeList,
  191.     Boolean askUser, OSType *fileType, StringPtr fullName);
  192. extern pascal void GetXResInfo(XCmdPtr paramPtr, short *resFile, short *resID);
  193. extern pascal void Notify(XCmdPtr paramPtr);
  194. extern pascal void SendHCEvent(XCmdPtr paramPtr, EventRecord *event);
  195. extern pascal void SendWindowMessage(XCmdPtr paramPtr, WindowPtr windPtr, 
  196.     StringPtr windowName, Handle msg);
  197. extern pascal WindowPtr FrontDocWindow(XCmdPtr paramPtr);
  198. extern pascal long StackNameToNum(XCmdPtr paramPtr, StringPtr stackName);
  199. extern pascal short ShowHCAlert(XCmdPtr paramPtr, short dlgID, StringPtr promptStr);
  200.  
  201. /****  Creating and Disposing XWindoids  ****/  /* ALL NEW */
  202. extern pascal WindowPtr NewXWindow(XCmdPtr paramPtr, Rect *boundsRect, StringPtr title, 
  203.    Boolean visible, short procID, Boolean color, Boolean floating);
  204. extern pascal WindowPtr GetNewXWindow(XCmdPtr paramPtr, ResType templateType, short 
  205.    templateID, Boolean color, Boolean floating);
  206. extern pascal void CloseXWindow(XCmdPtr paramPtr, WindowPtr window);
  207.  
  208. /****  XWindoid Utilities  ****/  /* ALL NEW */
  209. extern pascal void HideHCPalettes(XCmdPtr paramPtr);
  210. extern pascal void ShowHCPalettes(XCmdPtr paramPtr);
  211. extern pascal void RegisterXWMenu(XCmdPtr paramPtr, WindowPtr window, MenuHandle *menu, Boolean registering);
  212. extern pascal void SetXWIdleTime(XCmdPtr paramPtr, WindowPtr window, long interval);
  213. extern pascal void XWHasInterruptCode(XCmdPtr paramPtr, WindowPtr window, Boolean haveCode);
  214. extern pascal void XWAlwaysMoveHigh(XCmdPtr paramPtr, WindowPtr window, Boolean moveHigh);
  215. extern pascal void XWAllowReEntrancy(XCmdPtr paramPtr, WindowPtr window, Boolean allowSysEvts, Boolean allowHCEvts);
  216.  
  217. /****  Text Editing Utilities  ****/  /* ALL NEW */
  218. extern pascal void BeginXWEdit(XCmdPtr paramPtr, WindowPtr window);
  219. extern pascal void EndXWEdit(XCmdPtr paramPtr, WindowPtr window);
  220. extern pascal Ptr HCWordBreakProc(XCmdPtr paramPtr);
  221. extern pascal void PrintTEHandle(XCmdPtr paramPtr, TEHandle hTE, StringPtr header);
  222.  
  223. /****  Script Editor support  ****/  /* ALL NEW */
  224. extern pascal CheckPtHandle GetCheckPoints(XCmdPtr paramPtr);
  225. extern pascal void SetCheckPoints(XCmdPtr paramPtr, CheckPtHandle checkLines);
  226. extern pascal void FormatScript(XCmdPtr paramPtr, Handle scriptHndl, long *insertionPoint, Boolean quickFormat);
  227. extern pascal void SaveXWScript(XCmdPtr paramPtr, Handle scriptHndl);
  228. extern pascal void GetObjectName(XCmdPtr paramPtr, XTalkObjectPtr object, StringPtr objName);
  229. extern pascal void GetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle *scriptHndl);
  230. extern pascal void SetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr object, Handle scriptHndl);
  231.  
  232. /****  Debugging Tools support  ****/  /* ALL NEW */
  233. extern pascal void AbortScript(XCmdPtr paramPtr);
  234. extern pascal void GoScript(XCmdPtr paramPtr);
  235. extern pascal void StepScript(XCmdPtr paramPtr, Boolean stepInto);
  236. extern pascal void CountHandlers(XCmdPtr paramPtr, short *handlerCount);
  237. extern pascal void GetHandlerInfo(XCmdPtr paramPtr, short handlerNum, StringPtr handlerName, 
  238.                                   StringPtr objectName, short *varCount);
  239. extern pascal void GetVarInfo(XCmdPtr paramPtr, short handlerNum, short varNum, StringPtr varName, 
  240.                               Boolean *isGlobal, StringPtr varValue, Handle varHndl);
  241. extern pascal void SetVarValue(XCmdPtr paramPtr, short handlerNum, short varNum, Handle varHndl);
  242. extern pascal Handle GetStackCrawl(XCmdPtr paramPtr);
  243. extern pascal void TraceScript(XCmdPtr paramPtr, Boolean traceInto);
  244.  
  245.  
  246. #endif
  247.